Release 10.1A: OpenEdge Development:
Progress Dynamics Managers API Reference

Preface

This Preface contains the following sections:

Purpose
Audience
Organization
Using this manual
Public and private APIs
Typographical conventions
OpenEdge messages

Purpose

This manual provides a basic reference to the APIs that a developer uses to make calls to the Progress Dynamics® environment managers. Progress Dynamics is the Progress® OpenEdge® commercialization of the ongoing Internet Component Framework (ICF) project of the Progress Open Source Software Exchange (Progress POSSE, www.possenet.org).

Audience

This reference is intended for developers who design applications with Progress Dynamics.

Organization

This reference is organized as follows:

Chapter 1 "Configuration File Manager"

Describes the Configuration File Manager and its APIs.

Chapter 2 "Connection and Service Type Managers"

Describes the Connection and Service Type Managers and their APIs.

Chapter 3 "Customization Manager"

Describes the Customization Manager and its APIs.

Chapter 4 "General Manager"

Describes the General Manager and its APIs.

Chapter 5 "Localization Manager"

Describes the Localization Manager and its APIs.

Chapter 6 "Profile Manager"

Describes the Profile Manager and its APIs.

Chapter 7 "Referential Integrity Manager"

Describes the Referential Integrity Manager and its APIs.

Chapter 8 "Repository Managers"

Describes the Repository and Repository Design Managers and their APIs.

Chapter 9 "Security Manager"

Describes the Security Manager and its APIs.

Chapter 10 "Session Manager"

Describes the Session Manager and its APIs.

Chapter 11 "User Interface Manager"

Describes the User Interface Manager and its APIs.

Chapter 12 "Web Request Manager"

Describes the Web Request Manager and its APIs.

Using this manual

This reference discusses the application program interface (API) for the Progress Dynamics environment managers. Each chapter discusses a manager or group of related managers. Each chapter provides a general description of the manager, the temp-tables it uses, and the APIs that your applications should use to interact with the manager.

Because most of the files referenced are under the dynamics directory, most of the paths are relative to DLC\src\dynamics. The paths for files that are not under the dynamics directory are given relative to DLC\src.

Public and private APIs

The Progress Dynamics Managers contain many internal procedures and functions, but only a subset of them should be directly accessed by your applications. To differentiate between APIs that should be accessed and those that should not be accessed, the header comment for each API will include one of the following lines:

ACCESS_LEVEL=PUBLIC

or

ACCESS_LEVEL=PRIVATE

APIs marked PUBLIC are subject to a formal deprecation policy. APIs marked PRIVATE are intended solely to support the framework’s operation. They might be radically restructured or removed at any time to improve the framework’s performance. There will be no formal notification of changes to PRIVATE APIs. APIs that have not been marked as either PUBLIC or PRIVATE are being evaluated. They will be marked in future releases.

Typographical conventions

This manual uses the following typographical conventions:

Convention	Description
Bold	Bold typeface indicates commands or characters the user types, provides emphasis, or the names of user interface elements.
Italic	Italic typeface indicates the title of a document, or signifies new terms.
SMALL, BOLD CAPITAL LETTERS	Small, bold capital letters indicate OpenEdge® key functions and generic keyboard keys; for example, GET and CTRL.
KEY1+KEY2	A plus sign between key names indicates a simultaneous key sequence: you press and hold down the first key while pressing the second key. For example, CTRL+X.
KEY1 KEY2	A space between key names indicates a sequential key sequence: you press and release the first key, then press another key. For example, ESCAPE H.
Syntax:
Fixed width	A fixed-width font is used in syntax statements, code examples, system output, and filenames.
Fixed-width italics	Fixed-width italics indicate variables in syntax statements.
Fixed-width bold	Fixed-width bold indicates variables with special emphasis.
UPPERCASE fixed width	Uppercase words are Progress® 4GL language keywords. Although these are always shown in uppercase, you can type them in either uppercase or lowercase in a procedure.

OpenEdge messages

OpenEdge displays several types of messages to inform you of routine and unusual occurrences:

Execution messages inform you of errors encountered while OpenEdge is running a procedure; for example, if OpenEdge cannot find a record with a specified index field value.
Compile messages inform you of errors found while OpenEdge is reading and analyzing a procedure before running it; for example, if a procedure references a table name that is not defined in the database.
Startup messages inform you of unusual conditions detected while OpenEdge is getting ready to execute; for example, if you entered an invalid startup parameter.

After displaying a message, OpenEdge proceeds in one of several ways:

Continues execution, subject to the error-processing actions that you specify or that are assumed as part of the procedure. This is the most common action taken after execution messages.
Returns to the Progress Procedure Editor, so you can correct an error in a procedure. This is the usual action taken after compiler messages.
Halts processing of a procedure and returns immediately to the Progress Procedure Editor. This does not happen often.
Terminates the current session.

OpenEdge messages end with a message number in parentheses. In this example, the message number is 200:

** Unknown table name table. (200)

If you encounter an error that terminates OpenEdge, note the message number before restarting.

Obtaining more information about OpenEdge messages

In Windows platforms, use OpenEdge online help to obtain more information about OpenEdge messages. Many OpenEdge tools include the following Help menu options to provide information about messages:

Choose Help Recent Messages to display detailed descriptions of the most recent OpenEdge message and all other messages returned in the current session.
Choose Help Messages and then enter the message number to display a description of a specific OpenEdge message.
In the Procedure Editor, press the HELP key or F1.